Vcenter Identity Providers OidcSummary

The Vcenter Identity Providers OidcSummary schema contains commonly used information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so Vcenter Identity Providers OidcSummary contains discovered OAuth2 metadata.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "discovery_endpoint": "string",
    "logout_endpoint": "string",
    "auth_endpoint": "string",
    "token_endpoint": "string",
    "client_id": "string",
    "authentication_header": "string",
    "auth_query_params": {
        "auth_query_params": [
            "string"
        ]
    }
}

string As uri As uri

discovery_endpoint

Optional

Endpoint to retrieve the provider metadata

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

string As uri As uri

logout_endpoint

Optional

The endpoint to use for terminating the user's session at the identity provider. This value is automatically derived from the metadata information provided by the OIDC discovery endpoint.

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

string As uri As uri

auth_endpoint

Required

Authentication/authorization endpoint of the provider

This property was added in vSphere API 7.0.0.0.

string As uri As uri

token_endpoint

Required

Token endpoint of the provider

This property was added in vSphere API 7.0.0.0.

string

client_id

Required

Client identifier to connect to the provider

This property was added in vSphere API 7.0.0.0.

string

authentication_header

Required

The authentication data used as part of request header to acquire or refresh an OAuth2 token. The data format depends on the authentication method used. Example of basic authentication format: Authorization: Basic [base64Encode(clientId + ":" + secret)]

This property was added in vSphere API 7.0.0.0.

object

auth_query_params

Required

key/value pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:

If the value contains only one string, then the key is added with "k=v".
If the value is an empty list, then the key is added without a "=v".
If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.

This property was added in vSphere API 7.0.0.0.